<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.tftp;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.DatagramPacket;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.InetAddress;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/***<a name="line.23"></a>
<span class="sourceLineNo">024</span> * A final class derived from TFTPPacket definiing the TFTP Error<a name="line.24"></a>
<span class="sourceLineNo">025</span> * packet type.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Details regarding the TFTP protocol and the format of TFTP packets can<a name="line.27"></a>
<span class="sourceLineNo">028</span> * be found in RFC 783.  But the point of these classes is to keep you<a name="line.28"></a>
<span class="sourceLineNo">029</span> * from having to worry about the internals.  Additionally, only very<a name="line.29"></a>
<span class="sourceLineNo">030</span> * few people should have to care about any of the TFTPPacket classes<a name="line.30"></a>
<span class="sourceLineNo">031</span> * or derived classes.  Almost all users should only be concerned with the<a name="line.31"></a>
<span class="sourceLineNo">032</span> * {@link org.apache.commons.net.tftp.TFTPClient} class<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link org.apache.commons.net.tftp.TFTPClient#receiveFile receiveFile()}<a name="line.33"></a>
<span class="sourceLineNo">034</span> * and<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link org.apache.commons.net.tftp.TFTPClient#sendFile sendFile()}<a name="line.35"></a>
<span class="sourceLineNo">036</span> * methods.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @see TFTPPacket<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @see TFTPPacketException<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @see TFTP<a name="line.41"></a>
<span class="sourceLineNo">042</span> ***/<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>public final class TFTPErrorPacket extends TFTPPacket<a name="line.44"></a>
<span class="sourceLineNo">045</span>{<a name="line.45"></a>
<span class="sourceLineNo">046</span>    /*** The undefined error code according to RFC 783, value 0. ***/<a name="line.46"></a>
<span class="sourceLineNo">047</span>    public static final int UNDEFINED = 0;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /*** The file not found error code according to RFC 783, value 1. ***/<a name="line.49"></a>
<span class="sourceLineNo">050</span>    public static final int FILE_NOT_FOUND = 1;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>    /*** The access violation error code according to RFC 783, value 2. ***/<a name="line.52"></a>
<span class="sourceLineNo">053</span>    public static final int ACCESS_VIOLATION = 2;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /*** The disk full error code according to RFC 783, value 3. ***/<a name="line.55"></a>
<span class="sourceLineNo">056</span>    public static final int OUT_OF_SPACE = 3;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /***<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * The illegal TFTP operation error code according to RFC 783, value 4.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     ***/<a name="line.60"></a>
<span class="sourceLineNo">061</span>    public static final int ILLEGAL_OPERATION = 4;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    /*** The unknown transfer id error code according to RFC 783, value 5. ***/<a name="line.63"></a>
<span class="sourceLineNo">064</span>    public static final int UNKNOWN_TID = 5;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /*** The file already exists error code according to RFC 783, value 6. ***/<a name="line.66"></a>
<span class="sourceLineNo">067</span>    public static final int FILE_EXISTS = 6;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    /*** The no such user error code according to RFC 783, value 7. ***/<a name="line.69"></a>
<span class="sourceLineNo">070</span>    public static final int NO_SUCH_USER = 7;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    /*** The error code of this packet. ***/<a name="line.72"></a>
<span class="sourceLineNo">073</span>    int _error;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /*** The error message of this packet. ***/<a name="line.75"></a>
<span class="sourceLineNo">076</span>    String _message;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>    /***<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * Creates an error packet to be sent to a host at a given port<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * with an error code and error message.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * &lt;p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param destination  The host to which the packet is going to be sent.<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param port  The port to which the packet is going to be sent.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @param error The error code of the packet.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @param message The error message of the packet.<a name="line.85"></a>
<span class="sourceLineNo">086</span>     ***/<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public TFTPErrorPacket(InetAddress destination, int port,<a name="line.87"></a>
<span class="sourceLineNo">088</span>                           int error, String message)<a name="line.88"></a>
<span class="sourceLineNo">089</span>    {<a name="line.89"></a>
<span class="sourceLineNo">090</span>        super(TFTPPacket.ERROR, destination, port);<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>        _error = error;<a name="line.92"></a>
<span class="sourceLineNo">093</span>        _message = message;<a name="line.93"></a>
<span class="sourceLineNo">094</span>    }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /***<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * Creates an error packet based from a received<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * datagram.  Assumes the datagram is at least length 4, else an<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * ArrayIndexOutOfBoundsException may be thrown.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * &lt;p&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * @param datagram  The datagram containing the received error.<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * @throws TFTPPacketException  If the datagram isn't a valid TFTP<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *         error packet.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     ***/<a name="line.104"></a>
<span class="sourceLineNo">105</span>    TFTPErrorPacket(DatagramPacket datagram) throws TFTPPacketException<a name="line.105"></a>
<span class="sourceLineNo">106</span>    {<a name="line.106"></a>
<span class="sourceLineNo">107</span>        super(TFTPPacket.ERROR, datagram.getAddress(), datagram.getPort());<a name="line.107"></a>
<span class="sourceLineNo">108</span>        int index, length;<a name="line.108"></a>
<span class="sourceLineNo">109</span>        byte[] data;<a name="line.109"></a>
<span class="sourceLineNo">110</span>        StringBuilder buffer;<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>        data = datagram.getData();<a name="line.112"></a>
<span class="sourceLineNo">113</span>        length = datagram.getLength();<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>        if (getType() != data[1]) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>            throw new TFTPPacketException("TFTP operator code does not match type.");<a name="line.116"></a>
<span class="sourceLineNo">117</span>        }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span>        _error = (((data[2] &amp; 0xff) &lt;&lt; 8) | (data[3] &amp; 0xff));<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>        if (length &lt; 5) {<a name="line.121"></a>
<span class="sourceLineNo">122</span>            throw new TFTPPacketException("Bad error packet. No message.");<a name="line.122"></a>
<span class="sourceLineNo">123</span>        }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>        index = 4;<a name="line.125"></a>
<span class="sourceLineNo">126</span>        buffer = new StringBuilder();<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>        while (index &lt; length &amp;&amp; data[index] != 0)<a name="line.128"></a>
<span class="sourceLineNo">129</span>        {<a name="line.129"></a>
<span class="sourceLineNo">130</span>            buffer.append((char)data[index]);<a name="line.130"></a>
<span class="sourceLineNo">131</span>            ++index;<a name="line.131"></a>
<span class="sourceLineNo">132</span>        }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>        _message = buffer.toString();<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /***<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * This is a method only available within the package for<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * implementing efficient datagram transport by elminating buffering.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * It takes a datagram as an argument, and a byte buffer in which<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * to store the raw datagram data.  Inside the method, the data<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * is set as the datagram's data and the datagram returned.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * &lt;p&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @param datagram  The datagram to create.<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @param data The buffer to store the packet and to use in the datagram.<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @return The datagram argument.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     ***/<a name="line.147"></a>
<span class="sourceLineNo">148</span>    @Override<a name="line.148"></a>
<span class="sourceLineNo">149</span>    DatagramPacket _newDatagram(DatagramPacket datagram, byte[] data)<a name="line.149"></a>
<span class="sourceLineNo">150</span>    {<a name="line.150"></a>
<span class="sourceLineNo">151</span>        int length;<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>        length = _message.length();<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span>        data[0] = 0;<a name="line.155"></a>
<span class="sourceLineNo">156</span>        data[1] = (byte)_type;<a name="line.156"></a>
<span class="sourceLineNo">157</span>        data[2] = (byte)((_error &amp; 0xffff) &gt;&gt; 8);<a name="line.157"></a>
<span class="sourceLineNo">158</span>        data[3] = (byte)(_error &amp; 0xff);<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span>        System.arraycopy(_message.getBytes(), 0, data, 4, length);<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>        data[length + 4] = 0;<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>        datagram.setAddress(_address);<a name="line.164"></a>
<span class="sourceLineNo">165</span>        datagram.setPort(_port);<a name="line.165"></a>
<span class="sourceLineNo">166</span>        datagram.setData(data);<a name="line.166"></a>
<span class="sourceLineNo">167</span>        datagram.setLength(length + 4);<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span>        return datagram;<a name="line.169"></a>
<span class="sourceLineNo">170</span>    }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>    /***<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * Creates a UDP datagram containing all the TFTP<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * error packet data in the proper format.<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * This is a method exposed to the programmer in case he<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * wants to implement his own TFTP client instead of using<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * the {@link org.apache.commons.net.tftp.TFTPClient}<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * class.<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * Under normal circumstances, you should not have a need to call this<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * method.<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * &lt;p&gt;<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * @return A UDP datagram containing the TFTP error packet.<a name="line.183"></a>
<span class="sourceLineNo">184</span>     ***/<a name="line.184"></a>
<span class="sourceLineNo">185</span>    @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span>    public DatagramPacket newDatagram()<a name="line.186"></a>
<span class="sourceLineNo">187</span>    {<a name="line.187"></a>
<span class="sourceLineNo">188</span>        byte[] data;<a name="line.188"></a>
<span class="sourceLineNo">189</span>        int length;<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span>        length = _message.length();<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span>        data = new byte[length + 5];<a name="line.193"></a>
<span class="sourceLineNo">194</span>        data[0] = 0;<a name="line.194"></a>
<span class="sourceLineNo">195</span>        data[1] = (byte)_type;<a name="line.195"></a>
<span class="sourceLineNo">196</span>        data[2] = (byte)((_error &amp; 0xffff) &gt;&gt; 8);<a name="line.196"></a>
<span class="sourceLineNo">197</span>        data[3] = (byte)(_error &amp; 0xff);<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span>        System.arraycopy(_message.getBytes(), 0, data, 4, length);<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span>        data[length + 4] = 0;<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span>        return new DatagramPacket(data, data.length, _address, _port);<a name="line.203"></a>
<span class="sourceLineNo">204</span>    }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span>    /***<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * Returns the error code of the packet.<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * &lt;p&gt;<a name="line.209"></a>
<span class="sourceLineNo">210</span>     * @return The error code of the packet.<a name="line.210"></a>
<span class="sourceLineNo">211</span>     ***/<a name="line.211"></a>
<span class="sourceLineNo">212</span>    public int getError()<a name="line.212"></a>
<span class="sourceLineNo">213</span>    {<a name="line.213"></a>
<span class="sourceLineNo">214</span>        return _error;<a name="line.214"></a>
<span class="sourceLineNo">215</span>    }<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>    /***<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * Returns the error message of the packet.<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * &lt;p&gt;<a name="line.220"></a>
<span class="sourceLineNo">221</span>     * @return The error message of the packet.<a name="line.221"></a>
<span class="sourceLineNo">222</span>     ***/<a name="line.222"></a>
<span class="sourceLineNo">223</span>    public String getMessage()<a name="line.223"></a>
<span class="sourceLineNo">224</span>    {<a name="line.224"></a>
<span class="sourceLineNo">225</span>        return _message;<a name="line.225"></a>
<span class="sourceLineNo">226</span>    }<a name="line.226"></a>
<span class="sourceLineNo">227</span>}<a name="line.227"></a>




























































</pre>
</div>
</body>
</html>
